Duplicate management in software documentation maintenance
ثبت نشده
چکیده
Software today is becoming increasingly more complex and extensive, and its documentation is becoming more and more complicated. During the software life cycle documentation tends to accumulate a lot of duplicates due to copy-pasting: first, some text fragment is copied, possibly multiple times, then each copy is modified, possibly in its own way; thus, different copies of the initial fragment become near duplicates. Depending on the document type, duplicates can be either desired or not. In either case, they need to be managed during documentation lifecycle. This paper introduces a duplicate management process and shows how it could be applied in documentation maintenance. An example of duplicate management for industrial documentation is presented.
منابع مشابه
Detecting Near Duplicates in Software Documentation
Contemporary software documentation is as complicated as the software itself. During its lifecycle, the documentation accumulates a lot of “near duplicate” fragments, i.e. chunks of text that were copied from a single source and were later modified in different ways. Such near duplicates decrease documentation quality and thus hamper its further utilization. At the same time, they are hard to d...
متن کاملClone Detection in Reuse of Software Technical Documentation
As software documentation is becoming more and more complicated, efficiency of maintenance process could be increased through documentation reuse. In this paper, we apply software clone detection technique to automate searching of repeated fragments in software technical documentation to be reused. Our approach supports adaptive reuse, which means extracting “near duplicate” text fragments (rep...
متن کاملA Novel Approach to Detect Duplicate Code Blocks to Reduce Maintenance Effort
It was found in many cases that a code might be a clone for one programmer but not the same for another one. This problem occurs because of inaccurate documentation. According to research, the maintainers are not aware of the original design and thus, face the difficulty of agreeing on the system’s components and their relations or understanding the work of the application. The problem also occ...
متن کاملConceptual Model for a Software Maintenance Environment
A conceptual model for a software maintenance method named COMFORM (Configuration Management Formalization for Maintenance) is presented. COMFORM provides guidelines and procedures for carrying out the maintenance process, while establishing a systematic approach for the support of existing software systems. Incremental documentation, the process of building up the software documentation while ...
متن کاملTest Management Traceability Model to Support Software Testing Documentation
Software Documentation is one of the key quality factors in software development. However, many developers are still putting less effort and less priority on documentation. To them writing documentation during project development is very tedious and time consuming. As a result, the documentation tends to be significantly outdated , poor quality and difficult to access that will certainly lead t...
متن کامل